Skip to main content

SonarQube Connector

SonarQube Connector

Overview

SyncNow's DevOps Gate feature allows work systems to use SyncNow endpoints to enrich other connected work systems. SyncNow supports enriching work systems from SonarQube. Once a DevOps Gate process is defined, SyncNow can parse information received from SonarQube and set it in an entity on the target work systems. The DevOps Gate process includes mapping between a field received from SonarQube to the target work system field.

SonarQube Connector Features

The SonarQube connector reads and parses SonarQube webhook data and updates target systems accordingly. This allows you to enrich target systems such as JIRA with code quality information from SonarQube.

Setting Up the SonarQube System Connector

To set up the SonarQube connector, follow these steps:

  1. Navigate to Systems Page

    • Go to the Systems page in the SyncNow application.

  2. Add a New System

    • Press the Add System button. Add System Button

  3. Set Connector Name

    • Input a preferable name for the connection.

  4. Select Connector Type

    • Select “SonarQube” from the Type dropdown.

  5. Configure Self-Signed Certificates

    • Enable or disable the Allow Self-Signed Certificates toggle. This is important when the system API is under HTTP, not HTTPS.

  6. Input SonarQube Instance URL

    • Input the URL to your SonarQube instance.

  7. Set Authentication Details

    • Input the Username for authentication.
    • Add an Access Token to the instance. Follow the Create API token guide.

  8. Configure Webhook Security

    • Select a webhook security option. SyncNow supports IP restriction and secret key authentication. Learn more about webhook security.

  9. Verify Connection

    • Press the Verify Connection button to check if the connection is established successfully.

  10. Save the Connection

  • Press the Save button. Save Button

A new system connector has been created. New System Connector

Example: Enriching JIRA with SonarQube Data

DevOps Gate processes can use the SonarQube Connector to enrich target systems like JIRA. SyncNow will parse information received from SonarQube webhooks and update the corresponding entities in JIRA with code quality information.

For a detailed example of setting up the SonarQube Connector and enriching JIRA, refer to the example guide.

Compatibility

The SonarQube Connector supports SonarQube version 7.9 and later.